home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr28 / sdutils.zip / YAROB.DOC < prev   
Text File  |  1993-03-01  |  7KB  |  137 lines
  1. YAROB.DOC
  2.  
  3. (*****************************************************************************)
  4. (* (c) Copyright 1989,90,91                                                  *)
  5. (* MEMTEK Computer Services, 24 Loretta Ave, Wheelers Hill, 3150, Australia. *)
  6. (*****************************************************************************)
  7.  
  8. What is YAROB?
  9.  
  10. YAROB stands for Yet Another Read Only Batch Menu System. It is system for
  11. managing DOS batch files. It comes with a minimal set of sample menus that
  12. can be easily supplemented by the person that installs it. YAROB can run
  13. on freestanding DOS systems as well as networked PCs. YAROB is shareware
  14. to individuals, so if you wish to continue using it, you should register
  15. by sending $10 to the address above. Corporations and institutions can
  16. register for $100.
  17.  
  18. Who would want YAROB?
  19.  
  20. YAROB grew out of a need for a menu system that could be used by networked
  21. MS-DOS systems and shared by many users at one time that did not have any 
  22. write access to the fileserver disks. These basic requirements are common
  23. to many academic sites where networked computers have been provided for
  24. general purpose computing without accounts being issued to all and sundry.
  25.  
  26. As commercial DOS software becomes more memory hungry it is also important
  27. to minimize the overhead resource usage of any underlying menu system.
  28.  
  29. Being a read only menu system, it works cooperatively with virus protection 
  30. software so that unintentional modification to your system are easier to
  31. detect.
  32.  
  33. How does YAROB work?
  34.  
  35. YAROB consists of a main menu batch file (MENU.BAT) and the menu generation
  36. program (SETERROR.EXE). The menu batch file, once started, remains in
  37. operation until a menu option is selected that exits from the menu. Each
  38. time this endless loop starts, the menu generation program is invoked.
  39.  
  40. The menu generation program scans a predefined directory for batch files.
  41. The batch file names must be match a predefined format (00.bat to 29.BAT).
  42. As each is found, a little information is read so the user can see what the
  43. menu choices offer. Batch files can also carry their own context sensitive
  44. help, but this depends on the installer. The menu choices are presented to 
  45. the operator for selection. The users selection results in the setting of 
  46. the DOS errorlevel when the program exits. By this means, the program will 
  47. not be in memory when the selected batch file is executed.
  48.  
  49. As completely static batch files cannot cater for all circumstances, YAROB
  50. scans for references within the selected batch file to the DOS environment.
  51. Any characters within two percent signs will be picked up as a parameter and 
  52. its current value presented to the operator. The operator has the option of
  53. accepting the current value or entering a new one. If unsure about usage of
  54. the parameter, the operator can return to the menu without executing the
  55. batch file by pressing the escape key.
  56.  
  57. What resources does YAROB use?
  58.  
  59. When a YAROB selected batch file is in execution there will be two file
  60. handles in use, one for the main menu and one for the selected batch file.
  61. As YAROB makes use of the DOS environment for transfer of parameters to
  62. the selected batch file, it will probably become necessary to increase the
  63. size of the base environment from the default. This can be done by adding
  64. the following line to your CONFIG.SYS file on your boot disk.
  65.  
  66. shell=\command.com c:\ /e:512 /p
  67.  
  68. While the menu is displayed it is easy to check on environment usage by 
  69. pressing the escape key. YAROB will notify you if it runs out of environment
  70. space.
  71.  
  72. The menu batch files will consume some disk space.
  73.  
  74. How do I install YAROB?
  75.  
  76. Create a directory that will act as the repository of all the menu item
  77. batch files and then modify the start of the MENU.BAT file so that the
  78. environment variable MDIR contains the full directory name, including the
  79. slash at the end. example;
  80.  
  81. set mdir=c:\memtek\menu\
  82.  
  83. Copy the sample menu files to that directory.
  84.  
  85. Copy the MENU.BAT and SETERROR.EXE file to somewhere that is already on the
  86. DOS path.
  87.  
  88. When installing on a networked file server it is important to flag all
  89. the menu files as sharable.
  90.  
  91. How do I write my own menu items?
  92.  
  93. First write, and test a batch file that does what you want. You probably have
  94. a few candidates already on you root directory or somewhere on the PATH.
  95. The YAROB additions to the standard batch files are relatively simple. 
  96.  
  97. Batch files can carry comments. These are in the form of lines that start 
  98. with REM. The first REM line with a comment will be used by YAROB to make
  99. the menu selector and detail. The first word after the REM will be the
  100. selector and the rest of line will be the detail. By example the following
  101. line;
  102.  
  103. rem DOS Exit the Menu system and return to DOS prompt
  104.  
  105. Here the selector that will appear on the menu will be "DOS". The detail will 
  106. be "Exit the Menu system and return to DOS prompt". The detail will appear on
  107. line 25 at the bottom of the screen.
  108.  
  109. The lines in the file that start with REM HELP will be used by YAROB as help
  110. to be displayed when the operator presses the F1 key. By example;
  111.  
  112. rem help
  113. rem help Exit the Menu system and return to the DOS prompt
  114. rem help
  115. rem help Restores full command line control to the user outside the menu
  116. rem help system. To re-enter the menu system type MENU.
  117.  
  118. A word of warning about REM lines. Apparently DOS scans the lines of
  119. a batch file for pipes, file redirection and environment variables prior
  120. to noticing the REM denoting a comment line. This means that some characters
  121. should be avoided. In particular <,>,>>,| and %.
  122.  
  123. What about more batch files?
  124.  
  125. YAROB can currently support up to thirty menu selections on a single menu
  126. level and is designed to support many levels. The menu file prefix is 
  127. stored in the environment variable MDIR and this is how YAROB finds the menu
  128. items on any particular level. The prefix can contain a full file path and
  129. a string of characters with which the batch file names start. For example, my
  130. initial value for MDIR is C:\MEMTEK\MENU\ causes the menu generator to find
  131. all the files 00.BAT thru 99.BAT in that directory. If the prefix were to
  132. be changed to D:\OTHER\DEMO the menu generator will search the directory
  133. D:\OTHER for all files DEMO00.BAT thru DEMO99.BAT
  134.  
  135. The MENU.BAT file can be modified to support more items if you wish, but
  136. thirty seemed to be a reasonable compromise between speed and function.
  137.